Hybris UX Api

PATCH

This operation updates a customerProfile/creditScore entity in CRM. Please find the description of the request and response in the below section.
It is available for Costa Rica Fixed (CRM -Siebel), and PR (CRM-CSG) Fixed customers.

Request URL

http://[localhost]:[port]/ecom-ux/v1/{businessId}/customer/{id}

Base URI Parameter

Headers

Security Headers

Request Body

Actual implemenation for CR (Request Body)

{
    "contactMedium": [
      {
          "mediumType": "Email",
          "characteristic": {
              "emailAddress": "avinash.hari@abc.com",
              "contactType": "email"
          }
      }
    ],
    "characteristic": [
      {
          "name": "lob",
          "value": "FIXED"
      }
    ]
}

Actual implemenation for CR (Response Body) 200

{
  "id": "1-2H7FG6",
  "contactMedium": [
    {
      "mediumType": "Email",
      "characteristic": {
        "emailAddress": "avinash.hari@abc.com",
        "contactType": "email"
      }
    }
  ],
  "characteristic": [
    {
      "name": "lob",
      "value": "FIXED"
    }
  ]
}

Implementation for PR-BSS FIXED (Request Body)-CreditScore update use case

Key Points to be considered.

1. API only updates credit classification in BSS in the creditscore update use case. No other updates at the customer level.
2. account.id , creditProfile.characteristic.name and creditProfile.characteristic.value(where name=CreditClassification) are mandatory to update credit classification in BSS
3. Muleosft API is not validating the request. Error messages from BSS will be captured in the response.
4. creditScore field is optional and not mapped to BSS.

{
    "account": [
        {
            "id": "8211990010016418",
            "@type": "BillingAccount"
        }
    ],
    "creditProfile": [
        {
            "creditScore": "+687",
            "characteristic": [
                {
                    "name": "BillingAccountId",
                    "value": "8211990010016418"
                },
                {
                    "name": "CreditClassification",
                    "value": "A"
                }
            ]
        }
    ]
}

Implemenation for PR-BSS (Response Body)-CreditScore update use case

{
    "id": "1101521633110",
    "account": [
        {
            "id": "8211990010016418",
            "@type": "BillingAccount"
        }
    ],
    "creditProfile": [
        {
            "creditScore": "+687",
            "characteristic": [
                {
                    "name": "BillingAccountId",
                    "value": "8211990010016418"
                },
                {
                    "name": "CreditClassification",
                    "value": "A"
                }
            ]
        }
    ]
}

KEY CONSIDERATIONS FOR CR-b2c:

Mandatory fields and Possible values are mentioned in below table

Note: siebel bss returns 200 Ok , even if no fields are passed to update. Fields are updated only if fields are passed as described in request.